docs: add Quick Install section near top of README#149
Merged
simongdavies merged 1 commit intoMay 15, 2026
Conversation
- Add `## Quick Install` block (gh auth login + npm install -g + run) immediately after the warning callouts, so new users see the install path within the first screen - Link forward to the existing `## Install and Run` section for Docker, source builds, and full prerequisites - Prettier also realigned the capability table dividers in `How It Works` (pre-existing alignment drift from when the `execute_bash` row was added) — pure formatting, no content change Signed-off-by: Simon Davies <simongdavies@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a Quick Install section near the top of the README so new users see the npm install one-liner immediately, and includes a Prettier-driven realignment of an existing capability table.
Changes:
- New
## Quick Installblock withgh auth login,npm install -g, andhyperagentcommands, plus platform note and link to full install section. - Realigned capability table dividers in
How It Works(formatting only).
simongdavies
added a commit
that referenced
this pull request
May 15, 2026
Patch release covering three PRs merged after v0.6.0: • #149 — README quick-install section near the top for faster onboarding • #150 — @github/copilot dependency bump 1.0.39 → 1.0.48 • #151 — agent REPL UX overhaul (skill hot-reload, /skills <name> rewrite, marked-terminal v7 tight-list patch, MCP prerequisite surfacing, profile preview as markdown table, sandbox verbose-trace debug-log routing, built-in skill shadow protection, plus 2 review-round fixes for /skills reload rewrite + path traversal in skill detection) Signed-off-by: Simon Davies <simongdavies@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a
## Quick Installblock immediately after the warning/platform callouts so new readers see the npm one-liner within the first screen, instead of having to scroll pastWhy HyperAgent?,What Can You Do With HyperAgent?,Example Prompts,How It Works,Built-In Modules,Skills and Profiles,MCP Servers, andSecurity Modelbefore reachingInstall and Run.What's in the section
Followed by a one-line note on platform requirements (Node.js 22+, KVM/WHP/MSHV/WSL2) and a forward link to the full
Install and Runsection for Docker, source builds, and prerequisites.Notes
Install and Runsection (Docker, source builds, prerequisites, npm subsection, etc.) remains intact for users who need it.How It Works(pre-existing alignment drift from when theexecute_bashrow landed) — purely formatting, no content change. Visible in the diff but not behaviour-changing.Validation
npx prettier --check README.md— cleanmain@5a66988(just-released v0.6.0)